Documentation for class matrix_object

Inherits from 	control 

Properties declared in matrix_object 
	background_color 
	cells 
	cell_background_color 
	cell_height 
	cell_prototype 
	cell_width 
	does_autoscroll 
	font 
	intercell_height 
	intercell_width 
	is_background_transparent 
	is_cell_background_transparent 
	next_text 
	previous_text 

Class Methods declared in matrix_object 
	new 

Methods declared in matrix_object 
	action 
		add_row 
		clear_selected_cell 
		select_all 
		select_text 
		size_to_fit 
	any 
		add_row 
		background_color 
		boolean_value 
		cells 
		cell_background_color 
		cell_height 
		cell_prototype 
		cell_width 
		clear_selected_cell 
		does_autoscroll 
		find_cell_with_tag(tag) 
		float_value 
		font 
		insert_row_at(row) 
		integer_value 
		intercell_height 
		intercell_width 
		is_background_transparent 
		is_cell_background_transparent 
		load_items(items) 
		next_text 
		number_of_cells 
		number_of_rows 
		number_value 
		previous_text 
		remove_row_at(row) 
		selected_cell 
		selected_row 
		select_all 
		select_cell(cell) 
		select_cell_with_tag(tag) 
		select_text 
		set_background_color(color) 
		set_cell_background_color(color) 
		set_cell_height(height) 
		set_cell_prototype(cell) 
		set_cell_width(width) 
		set_does_autoscroll(boolean) 
		set_font(font) 
		set_intercell_height(height) 
		set_intercell_width(width) 
		set_is_background_transparent(boolean) 
		set_is_cell_background_transparent(boolean) 
		set_next_text(object) 
		set_previous_text(object) 
		set_value 
		size_to_fit 
		string_value 
		value 
	get 
		background_color 
		cells 
		cell_background_color 
		cell_height 
		cell_prototype 
		cell_width 
		does_autoscroll 
		font 
		intercell_height 
		intercell_width 
		is_background_transparent 
		is_cell_background_transparent 
		next_text 
		previous_text 
	set 
		set_background_color(color) 
		set_cell_background_color(color) 
		set_cell_height(height) 
		set_cell_prototype(cell) 
		set_cell_width(width) 
		set_does_autoscroll(boolean) 
		set_font(font) 
		set_intercell_height(height) 
		set_intercell_width(width) 
		set_is_background_transparent(boolean) 
		set_is_cell_background_transparent(boolean) 
		set_next_text(object) 
		set_previous_text(object) 

Class 
#begin_class
matrix_object 
The class matrix_object is a sub-class of the class gadget. 
The class matrix_object is a so-called abstract class. It implements the methods that is shared by form and matrix. 
Note: You cannot create instances of an abstract class.
A matrix object is a collection of rectangular cells organized into a number of rows and columns. All the cells in a matrix have the same size.
#end_class

Properties 

#begin_property
background_color 
Stores the color object for the background color of the matrix object as shown between the cells.
#end_property

#begin_property
cells 
Stores a collection of all the cells in the matrix object.
#end_property

#begin_property
cell_background_color 
Stores the color object for the background color of the cells.
#end_property

#begin_property
cell_height 
Stores the height of the cells in the matrix object.
#end_property

#begin_property
cell_prototype 
Stores a cell that will be used as a "prototype" when new cells are created in the matrix object.
#end_property

#begin_property
cell_width 
Stores the width of the cells in the matrix object.
#end_property

#begin_property
does_autoscroll 
Stores a boolean value. If is true and the matrix object is located in a scroller the scroller will scroll when the mouse is tracked in the matrix object.
#end_property

#begin_property
font 
Stores the default font of the cells in the matrix object.
#end_property

#begin_property
intercell_height 
Stores the vertical space between cells in the matrix object.
#end_property

#begin_property
intercell_width 
Stores the horizontal space between cells in the matrix object.
#end_property

#begin_property
is_background_transparent 
Stores a boolean value. It is true if the background of the matrix object, as shown between the cells, is transparent.
#end_property

#begin_property
is_cell_background_transparent 
Stores a boolean value. It is true if the background of the cells in the matrix object is transparent.
#end_property

#begin_property
next_text 
Stores a reference to the object that will get the insertion point when the insertion point is in the last cell of the matrix object and you press the tab key. Usually this is a text-field or another matrix.
#end_property

#begin_property
previous_text 
Stores a reference to the object that will get the insertion point when the insertion point is in the last cell of the matrix object and you press the tab key and at the same time have the shift-key pressed. Usually this is a text-field or another matrix.
#end_property

Methods 

#begin_method
add_row 
Adds a new row of cells at the end of the matrix object. 
Returns self.
Note: The lower left corner of the matrix object will have a fixed position.
#end_method

#begin_method
background_color 
Returns the background_color property of the matrix object.
#end_method

#begin_method
boolean_value 
Returns the boolean value of the selected cell.
#end_method

#begin_method
cells 
Returns the cells property of the matrix object.
#end_method

#begin_method
cell_background_color 
Returns the cell_background_color property of the matrix object.
#end_method

#begin_method
cell_height 
Returns the cell_height property of the matrix object.
#end_method

#begin_method
cell_prototype 
Returns the cell_prototype property of the matrix object.
#end_method

#begin_method
cell_width 
Returns the cell_width property of the matrix object.
#end_method

#begin_method
clear_selected_cell 
Clears the current selected cell.
Returns self.
#end_method

#begin_method
does_autoscroll 
Returns the does_autoscroll property of the matrix object.
#end_method

#begin_method
find_cell_with_tag(tag) 
Returns the first cell in the collection of cells with the tag tag. If no such cell exists the method returns nil.
#end_method

#begin_method
float_value 
Returns the float value of the selected cell.
#end_method

#begin_method
font 
Returns the font property of the matrix object.
#end_method

#begin_method
insert_row_at(row) 
Inserts a new row of cells at row. If row is not a valid row number the method returns nil.
Returns self.
#end_method

#begin_method
integer_value 
Returns the integer value of the selected cell.
#end_method

#begin_method
intercell_height 
Returns the intercell_height property of the matrix object.
#end_method

#begin_method
intercell_width 
Returns the intercell_width property of the matrix object.
#end_method

#begin_method
is_background_transparent 
Returns the is_background_transparent property of the matrix object.
#end_method

#begin_method
is_cell_background_transparent 
Returns the is_cell_background_transparent property of the matrix object.
#end_method

#begin_method
load_items(items) 
Makes the matrix a one-column matrix with one row per item in the collection items. The string value of the cells will be the value returned by each item in the collection items when they receive an as_string message.
Returns self.
Ex:
{matrix my_matrix}:load_items(["one" "two" 1123])
will make the matrix object have one column and three rows with the string values "one", "two" and "1123". 
#end_method

#begin_method
next_text 
Returns the next_text property of the matrix object.
#end_method

#begin_method
number_of_cells 
Returns the number of cells of the matrix object.
#end_method

#begin_method
number_of_rows 
Returns the number of rows of the matrix object.
#end_method

#begin_method
number_value 
Returns the number value of the selected cell.
#end_method

#begin_method
previous_text 
Returns the previous_text property of the matrix object.
#end_method

#begin_method
remove_row_at(row) 
Removes the row with the number row. If that row does not exist the method returns nil.
Returns self.
#end_method

#begin_method
selected_cell 
Returns the currently selected cell.
#end_method

#begin_method
selected_row 
Returns the row of the currently selected cell. If no cell is selected the method returns 0.
#end_method

#begin_method
select_all 
If the mode of the matrix object is not #radio_mode all the cells in the matrix object are selected. The currently selected cell is unaffected. Editable cells are not affected. 
Returns self. 
#end_method

#begin_method
select_cell(cell) 
Selects cell in the matrix object.
Returns self.
#end_method

#begin_method
select_cell_with_tag(tag) 
Selects the first cell in the collection of cells with the tag tag.
Returns self.
#end_method

#begin_method
select_text 
Selects the text in the first cell of the matrix object if it is a text-field cell.
Returns self.
#end_method

#begin_method
set_background_color(color) 
Sets the background_color property to color.
Returns self.
#end_method

#begin_method
set_cell_background_color(color) 
Sets the cell_background_color property to color.
Returns self.
#end_method

#begin_method
set_cell_height(height) 
Sets the cell_height property to height.
Returns self.
#end_method

#begin_method
set_cell_prototype(cell) 
Sets the cell_prototype property to cell.
Returns self.
#end_method

#begin_method
set_cell_width(width) 
Sets the cell_width property to width.
Returns self.
#end_method

#begin_method
set_does_autoscroll(boolean) 
Sets the does_autoscroll property to boolean.
Returns self.
#end_method

#begin_method
set_font(font) 
Sets the font property to font.
Returns self.
#end_method

#begin_method
set_intercell_height(height) 
Sets the intercell_height property to height.
Returns self.
#end_method

#begin_method
set_intercell_width(width) 
Sets the intercell_width property to width.
Returns self.
#end_method

#begin_method
set_is_background_transparent(boolean) 
Sets the is_background_transparent property to boolean.
Returns self.
#end_method

#begin_method
set_is_cell_background_transparent(boolean) 
Sets the is_cell_background_transparent property to boolean.
Returns self.
#end_method

#begin_method
set_next_text(object) 
Sets the next_text property to object.
Returns self.
#end_method

#begin_method
set_previous_text(object) 
Sets the previous_text property to object.
Returns self.
#end_method

#begin_method
set_value(value) 
Sends a set_value(value) to the selected cell. Returns the return value of that message. 
#end_method

#begin_method
size_to_fit 
Resizes the cells so that the largest cell can display its contents. The matrix object will resize accordingly.
Returns self.
#end_method

#begin_method
string_value 
Returns the string value of the selected cell.
#end_method

#begin_method
value 
Returns the value of the selected cell.
#end_method

Class Methods 

#begin_class_method
new 
You cannot create instances of the class matrix_object since it is an abstract class.
Ex:
{matrix_object}:new
raises an exception
Exception:
The message new was sent to the class matrix_object but matrix_object is an abstract class which you can't make instances of
#end_class_method